sphinx Add support for markdown files #9139
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal:
This adds support to use markdown files to generate the
documentation. The existing
rst
files still work and this allows tomix them with markdown files. Both formats coexist without any
friction.
This way, a contributor can use its favorite format. Besides, markdown
syntax is considered easier to write than the rst one. This might
attract new contributors to the project.
This also introduces a new dependency for markdown parsing:
myst-parser
.See: https://www.sphinx-doc.org/en/master/usage/markdown.html
Related: https://github.com/qgis/QGIS-Website/pull/1255